# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Hero Core Template

game: Hero Core
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.

Hero Core:
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  ################
  # Goal Options #
  ################
  difficulty:
    # What game difficulty your world will be played on.
    normal: 50
    hard: 0
    annihilation: 0

  goal_computers:
    # How many computers are required for you to enter the Final Boss room and complete the game.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 10
    0: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-10: 0 # random value between 0 and 10

  ###################
  # Shuffle Options #
  ###################
  powerups:
    # If enabled, the Powerups obtained from defeating bosses will contain random items,
    # and the Blade, Suit, Blaster, and Pattern Scanner Power Ups can appear anywhere in the multiworld.
    # Otherwise, they will be locked behind bosses at their vanilla locations.
    # If your chosen difficulty is Annihilation, this option does nothing.
    'false': 0
    'true': 50

  level_ups:
    # If enabled, the Levelups obtained from defeating bosses will contain random items, 
    # and your Levelups can appear anywhere in the multiworld.
    # Otherwise they will be locked to their vanilla locations.
    # If your chosen difficulty is Annihilation, this option does nothing.
    'false': 50
    'true': 0

  computers:
    # If enabled, Computers will contain random items, and your Computer items can appear anywhere in the multiworld.
    # Otherwise, the computers will be locked to their vanilla locations.
    'false': 0
    'true': 50

  generators:
    # If enabled, destroying a generator will send a random item, 
    # and items that remove barriers around a generator can appear anywhere in the multiworld.
    'false': 0
    'true': 50

  save_points:
    # If enabled, each Save Point in the game will contain a random item,
    # and items containing a warp to each Save Point can appear anywhere in the multiworld.
    # You can still warp to Save Points that you reach, even if you don't have the respective item.
    # You may also additionally choose to remove the Pattern Scanner from your world.
    'off': 50
    shuffle_saves: 0
    shuffle_saves_no_scanner: 0

  doors:
    # If enabled, defeating all enemies in a room containing a locked door will send a random item,
    # and items that open doors in a given room can appear anywhere in the multiworld.
    'false': 50
    'true': 0

  #################
  # Miscellaneous #
  #################
  miscellaneous_locations:
    # If enabled, a variety of miscellaneous locations will contain random items.
    # This includes the Ship Scan and the Shapeshift Computer in all difficulties,
    # Zero, the Expel Computer, and the Speedrun Times Computer in Normal and Hard,
    # a hidden Flower in Hard, and a Gravestone in Annihilation
    'false': 50
    'true': 0

  expel_skips:
    # Whether or not the logic should expect the player to use Expel to kill otherwise out-of-reach enemies.
    # In Normal and Hard, this will allow you to enter a few areas without the Suit upgrades.
    # In Annihilation, this option does nothing.
    'false': 50
    'true': 0

  deathlink:
    # When you die, everyone who enabled death link dies. Of course, the reverse is true too.
    'false': 50
    'true': 0

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
